Fix SDK bug in the `deployTrigger` method #16934

jverce · 2025-06-02T21:27:10Z

WHY

The deployTrigger method was ignoring the workflowId argument when calling the API, which prevented the new trigger from emitting events to the target workflow.

Summary by CodeRabbit

Bug Fixes
- Resolved an issue where the workflow ID was not being sent when deploying a trigger.
Chores
- Updated documentation to reflect the latest changes.
- Bumped the SDK version to 1.6.5.

The `deployTrigger` method was ignoring the `workflowId` argument when calling the API, which prevented the new trigger from emitting events to the target workflow.

vercel · 2025-06-02T21:27:16Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jun 2, 2025 9:27pm

vercel · 2025-06-02T21:27:17Z

@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2025-06-02T21:27:17Z

Walkthrough

This update increments the SDK version to 1.6.5, documents the release in the changelog, and modifies the deployTrigger method in the BaseClient class to include the workflow_id in its API request body.

Changes

File(s)	Change Summary
packages/sdk/CHANGELOG.md	Added changelog entry for version 1.6.5, noting the deployTrigger fix.
packages/sdk/package.json	Updated package version from 1.6.4 to 1.6.5.
packages/sdk/src/shared/index.ts	Modified `deployTrigger` to include `workflow_id` in request body.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant BaseClient
    participant API

    Caller->>BaseClient: deployTrigger({ workflowId })
    BaseClient->>API: POST /deploy-trigger { workflow_id: workflowId }
    API-->>BaseClient: Response
    BaseClient-->>Caller: Result

Poem

A hop and a skip, a version anew,
The changelog’s updated, the trigger comes through!
Now workflow_id travels with care,
Ensuring deployments are handled fair.
With 1.6.5, the SDK’s in stride—
Hopping ahead, with bugs set aside! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/sdk/src/shared/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:170:49)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 38dac8f and 71e2dcd.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (3)

packages/sdk/CHANGELOG.md (1 hunks)
packages/sdk/package.json (1 hunks)
packages/sdk/src/shared/index.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: pnpm publish
GitHub Check: Lint Code Base

🔇 Additional comments (3)

packages/sdk/src/shared/index.ts (1)

1484-1484: LGTM! Core bug fix correctly implemented.

The addition of workflow_id: opts.workflowId, to the request body properly addresses the issue described in the PR objectives. The field name follows snake_case convention consistent with the API contract, and the implementation matches the existing pattern used for webhook_url.

Note: Since workflowId is optional, the field will be included in the request body even when undefined. This should be acceptable as most APIs handle optional undefined fields gracefully.

packages/sdk/package.json (1)

4-4: LGTM! Appropriate version bump for bug fix.

The patch version increment from 1.6.4 to 1.6.5 correctly follows semantic versioning conventions for a bug fix release.

packages/sdk/CHANGELOG.md (1)

5-10: LGTM! Well-documented changelog entry.

The changelog entry properly documents the bug fix with appropriate versioning, dating, and clear description of the change. This helps users understand what was fixed in version 1.6.5.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This pull request fixes a bug in the deployTrigger method by ensuring that the workflowId is correctly passed to the API.

Added workflow_id to the payload in deployTrigger
Version bump and changelog update for the SDK

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.

File	Description
packages/sdk/src/shared/index.ts	Adds the workflow_id field to the API payload
packages/sdk/package.json	Updates the package version to 1.6.5
packages/sdk/CHANGELOG.md	Documents the fix for deployTrigger

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

Fix SDK bug in the deployTrigger method

71e2dcd

The `deployTrigger` method was ignoring the `workflowId` argument when calling the API, which prevented the new trigger from emitting events to the target workflow.

jverce requested a review from Copilot June 2, 2025 21:27

jverce self-assigned this Jun 2, 2025

jverce added bug Something isn't working pd-api Pipedream API requests javascript Pull requests that update Javascript code tracked internally Issue is also tracked in our internal issue tracker prioritized Prioritized issue labels Jun 2, 2025

Copilot AI reviewed Jun 2, 2025

View reviewed changes

dannyroosevelt approved these changes Jun 2, 2025

View reviewed changes

jverce merged commit 2799a70 into PipedreamHQ:master Jun 2, 2025
11 of 12 checks passed

jverce deleted the fix/deploy-trigger-workflow-id branch June 2, 2025 21:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix SDK bug in the `deployTrigger` method #16934

Fix SDK bug in the `deployTrigger` method #16934

Uh oh!

jverce commented Jun 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jun 2, 2025

Uh oh!

vercel bot commented Jun 2, 2025

Uh oh!

coderabbitai bot commented Jun 2, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Fix SDK bug in the deployTrigger method #16934

Fix SDK bug in the deployTrigger method #16934

Uh oh!

Conversation

jverce commented Jun 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

WHY

Summary by CodeRabbit

Uh oh!

vercel bot commented Jun 2, 2025

Uh oh!

vercel bot commented Jun 2, 2025

Uh oh!

coderabbitai bot commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Fix SDK bug in the `deployTrigger` method #16934

Fix SDK bug in the `deployTrigger` method #16934

jverce commented Jun 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)